下班工具箱的后端基于 FastAPI 构建,提供本地 HTTP 接口供客户端调用。
http://127.0.0.1:7410(可在设置中修改)/api/v1/ 开头后端通过 EDUASSIST_TOKEN 环境变量开启 Bearer Token 认证:
/health 与 OPTIONS 预检请求)都要求请求头携带 Authorization: Bearer <token>。401,响应体为 {"detail": "Unauthorized"}。GET /health:探测后端是否在线,返回 {"status": "ok"}。| 模块 | 说明 |
|---|---|
| 成绩相关 | 成绩单制作、成绩分析 |
| PDF 相关 | PDF 合并、拆分、压缩 |
| 津贴相关 | 校历、假期修改、签到统计 |
| 认证 | 用户注册 |
| 配置 | 读取、更新配置 |
业务校验失败时返回对应 HTTP 状态码,响应体结构统一为:
{ "detail": "错误信息" }常见的错误码:
| 状态码 | 含义 |
|---|---|
| 400 | 请求参数不合法 / 业务校验失败 |
| 401 | 未认证(token 缺失或错误) |
| 404 | 接口不存在 |
| 422 | 请求体字段校验失败 |
| 500 | 服务器内部错误 |
下班工具箱的后端基于 FastAPI 构建,提供本地 HTTP 接口供客户端调用。
http://127.0.0.1:7410(可在设置中修改)/api/v1/ 开头后端通过 EDUASSIST_TOKEN 环境变量开启 Bearer Token 认证:
/health 与 OPTIONS 预检请求)都要求请求头携带 Authorization: Bearer <token>。401,响应体为 {"detail": "Unauthorized"}。GET /health:探测后端是否在线,返回 {"status": "ok"}。| 模块 | 说明 |
|---|---|
| 成绩相关 | 成绩单制作、成绩分析 |
| PDF 相关 | PDF 合并、拆分、压缩 |
| 津贴相关 | 校历、假期修改、签到统计 |
| 认证 | 用户注册 |
| 配置 | 读取、更新配置 |
业务校验失败时返回对应 HTTP 状态码,响应体结构统一为:
{ "detail": "错误信息" }常见的错误码:
| 状态码 | 含义 |
|---|---|
| 400 | 请求参数不合法 / 业务校验失败 |
| 401 | 未认证(token 缺失或错误) |
| 404 | 接口不存在 |
| 422 | 请求体字段校验失败 |
| 500 | 服务器内部错误 |